/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007-2008 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.projects.toolbox_basics_project.spring.manager;

import com.genia.toolbox.basics.bean.DataContainer;
import com.genia.toolbox.basics.exception.technical.TechnicalException;
import com.genia.toolbox.projects.toolbox_basics_project.bean.model.Template;
import com.genia.toolbox.projects.toolbox_basics_project.web.command.TemplateCommand;

/**
 * Manager to handle templates.
 */
public interface TemplateManager
{

  /**
   * the name of the template descriptor file in the template bundle.
   */
  public static final String TEMPLATE_DESCRIPTOR_FILE = "templateDescriptor.xml";

  /**
   * the name of the template type descriptor file in the template bundle.
   */
  public static final String TEMPLATE_TYPE_DESCRIPTOR_FILE = "templateTypeDescriptor.xml";



  /**
   * import a {@link DataContainer} containing a template into the application.
   * 
   * @param templateDataContainer
   *          the {@link DataContainer} containing the template
   * @throws TechnicalException
   *           if an error occured
   */
  public abstract void importTemplate(DataContainer templateDataContainer)
      throws TechnicalException;



  /**
   * returns the {@link DataContainer} associated to the given path for the
   * given {@link Template}. This method will look to parent {@link Template}s
   * if the given path does not exist in the given {@link Template}.
   * 
   * @param template
   *          the {@link Template} to use
   * @param path
   *          the path of the data to retrieve
   * @return the {@link DataContainer} representing the datas at the given path
   *         in the given template or <code>null</code> if no such data exists
   * @throws TechnicalException
   *           if an error occured
   */
  public abstract DataContainer getDataContainer(Template template, String path)
      throws TechnicalException;



  /**
   * returns the {@link DataContainer} associated to the given path for the
   * {@link Template} described by the {@link TemplateCommand}.
   * 
   * @param templateCommand
   *          the {@link TemplateCommand} describing the {@link Template}.
   * @param path
   *          the path of the data to retrieve
   * @return the {@link DataContainer} associated to the given path for the
   *         {@link Template} described by the {@link TemplateCommand} or
   *         <code>null</code> if no such data exists
   * @throws TechnicalException
   *           if an error occured
   */
  public abstract DataContainer getDataContainer(TemplateCommand templateCommand, String path)
      throws TechnicalException;



  /**
   * returns a {@link DataContainer} associated to a file contained in the given
   * path for the given {@link Template}. This method will look to parent
   * {@link Template}s if the given path does not exist in the given
   * {@link Template}.
   * 
   * @param template
   *          the {@link Template} to use
   * @param path
   *          the path of the data to retrieve
   * @return a {@link DataContainer} associated to a file contained in the given
   *         path in the given template or <code>null</code> if no such data
   *         exists
   * @throws TechnicalException
   *           if an error occured
   */
  public abstract DataContainer getRandomDataContainer(Template template, String path)
      throws TechnicalException;



  /**
   * returns a {@link DataContainer} associated to a file contained in the given
   * path for the {@link Template} described by the {@link TemplateCommand}.
   * 
   * @param templateCommand
   *          the {@link TemplateCommand} describing the {@link Template}.
   * @param path
   *          the path of the data to retrieve
   * @return a {@link DataContainer} associated to a file contained in the given
   *         path for the {@link Template} described by the
   *         {@link TemplateCommand} or <code>null</code> if no such data
   *         exists
   * @throws TechnicalException
   *           if an error occured
   */
  public abstract DataContainer getRandomDataContainer(TemplateCommand templateCommand, String path)
      throws TechnicalException;

}
